Gestion des droits d'accès — Comptes de service
L'aperçu des comptes de service affiche tous les utilisateurs existants, par ordre alphabétique.
Chaque colonne contient le nom du compte de service et la date de dernière modification.
Pour trier l'aperçu, cliquez sur l'en-tête de la colonne correspondante.
Le champ Rechercher en haut à droite permet d'effectuer des recherches dans la liste des comptes de service en fonction de leurs noms.
À partir cet aperçu, vous pouvez :
- Créer un nouveau compte de service — Voir ci-dessous.
- Supprimer un compte de service existant — En cliquant sur la corbeille à la fin d'une ligne.
- Modifier un compte de service existant — En cliquant sur un nom. Les propriétés s'affichent dans une fenêtre coulissante sur la droite.
Deux onglets s'affichent lors de la modification d'un compte de service :
- Général — Propriétés générales d'un compte de service
- Point de terminaison — Droits d'exploitation sur les points de terminaison de l'API. Cet onglet n'est visible que pour les comptes de service personnalisés. Pour les comptes de service spécifiques à l'intégration (Recommendations et Site), les points de terminaison API sont fixes et ne peuvent être visualisés ou modifiés ici.
Créer un compte de service
Pour créer un nouveau compte de service, cliquez sur le bouton Nouveau en haut à droite.
Les propriétés s'affichent dans une fenêtre coulissante sur la droite.
Saisissez le nom du compte de service.
Sélectionnez le type de compte de service.
- Personnalisé: Utilisé par l’API Selligent, par exemple.
- Recommendations: utilisé pour l’intégration entre Recommendations et Selligent.
- Site: utilisé pour l’intégration entre Selligent et Site. Cette information doit être ajoutée dans la section de configuration de l'univers.
- Rendu: utilisé lors de l'activation de l'exigence d'autorisation sécurisée dans les Custom Journeys. Utilisez la clé et le secret générés pour ce compte de service pour créer l'en-tête d'autorisation. (Cela se fait en combinant la clé et le secret avec deux points et en codant la clé combinée en base64. Ce sont vos informations d'identification qui peuvent être utilisées pour l'autorisation de base.)
- Loyalty: Utilisé pour l'intégration entre Loyalty et Selligent.
- Luzmo: Utilisé pour l'intégration à Luzmo, l'outil utilisé pour la création et la gestion des tableaux de bord.
Enregistrez-le.
Une clé d'authentification et une clé secrète sont générées automatiquement et peuvent être utilisées dans l'API.
Une date d'expiration peut être définie. L'utilisateur peut choisir à partir de valeurs prédéfinies ou définir une date d'expiration personnalisée. Ensuite, la date est automatiquement calculée et ajoutée. Quand la date d'expiration a été atteinte ou qu'aucune date d'expiration n'est définie, l'utilisateur en est informé.
Remarque : Quand la date d'expiration a été atteinte, la clé et la clé secrète peuvent être renouvelées directement depuis le compte de service, à partir du panneau de configuration. Cliquez sur Renouveler et une nouvelle clé et un nouveau secret sont créés. Vous pouvez également définir une nouvelle date d'expiration, auquel cas la clé et clé secrète restent inchangées.
Cela signifie qu'une nouvelle clé est générée et devient automatiquement la clé actuelle. L'ancienne clé reste valide pendant 2 semaines pour fournir des fonctionnalités d'API aux applications existantes pendant qu'elles sont mises à jour avec la nouvelle clé. Après 2 semaines, l'ancienne clé devient invalide.
Le cas échéant, le filtrage IP peut aussi être activé. C'est la garantie que seuls les appels émanant d'adresses IP données sont pris en compte. Si un appel est effectué à partir de l'API d'une adresse IP différente, il ne sera pas pris en compte.
Vous pouvez aussi filtrer les Unités commerciales pouvant accéder à ce compte de service. Dans ce cas, les appels d'API utilisant ce compte de service ne fonctionnent que pour les Unités commerciales figurant dans la liste. Activez l'option et ajoutez les Unités commerciales. Lorsque l'option est activée, vous devez sélectionner au moins une Unité commerciale.
Cliquez sur Enregistrer.
Définir les points de terminaison (comptes de service personnalisés uniquement)
L'onglet Points de terminaison fournit une présentation de tous les points de terminaison disponibles et des diverses opérations autorisées sur ces derniers.
Cochez les cases pour sélectionner les points de terminaison accessibles pour le compte de service en cours.
Enregistrez votre tâche quand vous avez terminé.
Remarque: Quand aucun point de terminaison n'a été sélectionné, le compte de service ne bénéficie d'aucun accès.
Remarque technique: Quand un compte de service n'est pas autorisé à utiliser un point de terminaison, l'API renvoie un code et un message de réponse HTTP « 403 - Interdit ».
Accéder à un compte de service pour afficher les clés d'authentification d'API
Quand vous accédez à un compte de service, les propriétés s'affichent dans une fenêtre coulissante sur la droite.
La page Nom s'affiche.
La clé d'authentification et la clé secrète qui s'affichent peuvent être utilisées dans l'API.
Accéder à l'API (comptes de service personnalisés uniquement)
L'API est accessible à partir d'une URL dédiée liée à votre environnement. (par exemple http://VOTRE_ENVIRONNEMENT/Portal/Api/swagger/)
Au lancement de l'Explorateur d'API, saisissez la clé d'authentification et la clé secrète dans le coin supérieur droit. Vous pouvez désormais tester les méthodes API.
Remarque: La documentation concernant l'API et l'utilisation des méthodes se trouve directement dans l'Explorateur d'API, accessible depuis l'entrée Modules de la barre d'outils.
Vous pouvez également accéder au DevPortal pour des informations plus détaillées sur l'API via l'URL suivante: https://developers.meetmarigold.com/engage/api/ ou depuis l'entrée Modules dans la barre d'outils.
Limites de débit d'API
Limites de débit
Une limite de débit définit le nombre de requêtes qui peuvent être adressées à l'API REST au cours d'une période donnée. Si cette limite est dépassée sur une période, l'application est bridée et les requêtes d'API au-dessus de la limite sont rejetées.
Le bridage est lié à la configuration Comptes de service dans Selligent et s'applique à sa clé d'API associée.
Limites de l'API pour l'API REST Selligent
Toutes les requêtes d'API REST Selligent sont soumises à des limites de débit. Une clé d'API est autorisée à effectuer jusqu'à 2500 requêtes par minute sur tous les chemins d'API.
Remarque: Les limites d'API ne s'appliquent qu'à l'API REST Selligent. Les API REST Campaign et Direct Mail ne sont pas soumises à ces limites.
Réponses lorsque le nombre de requêtes est limité
Si les requêtes s'effectuent à un débit supérieur aux limites de :
- 2500 requêtes/minute
Ces requêtes reçoivent alors le code de statut HTTP 429 (trop de requêtes), ainsi qu'un message, comme ci-dessous, dans le corps de la réponse.
Exemple: Le quota d'appels de l'API a été dépassé ! Le maximum autorisé est de 2 500 par minute.
Les en-têtes de réponse affichent des informations supplémentaires sur l'état de limitation de débit.
Exemple:
X-RateLimit-Limit: 2500
X-RateLimit-Remaining: 50
X-RateLimit-Reset: 5
- X-RateLimit-Limit — Représente le nombre maximum de requêtes autorisées dans la fenêtre de temps.
- X-RateLimit-Remaining — Représente le nombre de requêtes restantes dans la fenêtre actuelle (1 minute).
- X-RateLimit-Reset — Représente le temps restant dans la fenêtre actuelle, exprimé en secondes.
Dans le cas où l'API REST Selligent est sous forte charge ou en panne pour maintenance, le code de statut HTTP 503 (service non disponible) est renvoyé.
Limite de requêtes entrantes de l'API
La plupart des points de terminaison d'API ont des limites entrantes définies comme suit :
Limite de requêtes entrantes par défaut
- Limité par un délai de connexion de 15 secondes, ce qui signifie que les données doivent être postées et traitées dans les 15 secondes.
- La taille des données est limitée à 2 Mo.
- Le taux par défaut est limité à 2 500 requêtes/minute.
Les points de terminaison « POST /data/load » prennent en charge des limites de requêtes entrantes plus élevées, selon le mode de transfert de données.
Il n'existe actuellement aucune contrainte de validation de quantité sur :
- Le nombre de champs par fiche.
- Le nombre total de fiches renvoyées.
Remarque: Le nombre de champs et le nombre de fiches sont limités par la taille de l'objet de données total.
Exemple: un nombre plus important de champs signifie un nombre moins important de fiches pouvant être soumises, et vice versa.
/data/load SYNC MODE
- Limité par un délai de connexion de 15 secondes, ce qui signifie que les données doivent être postées et traitées dans les 15 secondes.
- La taille des données est limitée à 20 Mo.
- Le nombre de champs de données n'est pas spécifiquement limité.
- Le nombre de fiches dépend du nombre de champs.
- Le taux par défaut est limité à 2 500 requêtes/minute.
/data/load STREAMED MODE
- Pas de limite de temps de connexion.
- Les données sont limitées à 20 Mo.
- Le nombre de champs de données n'est pas spécifiquement limité.
- Le nombre de fiches dépend du nombre de champs.
- Le taux par défaut est limité à 2 500 requêtes/minute.
Limites de réponses sortantes de l'API
La limite de réponses est généralement basée sur la totalité des sorties de données et le temps nécessaire pour récupérer le jeu de données, qui se reflète dans le nombre de champs définis. Si le nombre de champs est bas, le résultat peut être plus élevé.
Limite de requêtes sortantes par défaut
- Limité par un délai de connexion de 15 secondes, ce qui signifie que les données sont requises et renvoyées dans les 15 secondes.
- Le taux par défaut est limité à 2 500 requêtes/minute.
Les points de terminaison « POST /data/search » prennent en charge des limites de réponses sortantes plus élevées, selon le mode de transfert de données.
Il n'existe actuellement aucune contrainte sur :
- Le nombre de champs d'exportation.
- Le nombre de fiches.
MAIS la combinaison du nombre de champs et du nombre de fiches est limitée par la taille de l'objet de données total.
/data/search SYNC MODE
- Pas de limites de délai.
- Il est conseillé de limiter le nombre de fiches à un « résultat » de 2500.
- Les données sont limitées à un maximum de 1 Mo par fiche.
- Le taux par défaut est limité à 2 500 requêtes/minute.
/data/search STREAMED MODE
- Pas de limites de délai.
- Les données sont limitées à un maximum de 1 Mo par fiche.
- Le taux par défaut est limité à 2 500 requêtes/minute.
